/**
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.lucene.spatial.base.prefix;

import java.util.List;

import org.apache.lucene.spatial.base.Shape;

public interface SpatialPrefixGrid
{
  public static final char COVER = '*';
  public static final char INTERSECTS = '+';

  /**
   * Get a list of tokens that describe the shape within the grid
   */
  public List<CharSequence> readCells( Shape geo );

  /**
   * Find a reasonable level of detail for a given shape
   */
  public int getBestLevel( Shape geo );

  /**
   * Get the shape for a given cell description
   */
  public Shape getCellShape( CharSequence seq );
}
